Skip to content

chore: cd workflow#3935

Merged
d-v-b merged 8 commits into
zarr-developers:mainfrom
d-v-b:chore/publish-metadata-package
May 17, 2026
Merged

chore: cd workflow#3935
d-v-b merged 8 commits into
zarr-developers:mainfrom
d-v-b:chore/publish-metadata-package

Conversation

@d-v-b
Copy link
Copy Markdown
Contributor

@d-v-b d-v-b commented May 2, 2026

this adds a cd workflow for zarr-metadata

we either publish to pypi, in which case the version declared in the package is used, or we publish to testpypi, in which case a synthetic, unique version is created to ensure that we never have a conflict on testpypi.

this workflow only supports workflow dispatch right now. later PRs will add a tag-based release workflow.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions Bot added the needs release notes Automatically applied to PRs which haven't added release notes label May 2, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 2, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.32%. Comparing base (be160fd) to head (9750059).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #3935   +/-   ##
=======================================
  Coverage   93.32%   93.32%           
=======================================
  Files          88       88           
  Lines       11827    11827           
=======================================
  Hits        11037    11037           
  Misses        790      790
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@d-v-b d-v-b requested review from ilan-gold and maxrjones May 2, 2026 15:17
@ilan-gold
Copy link
Copy Markdown
Contributor

ilan-gold commented May 6, 2026

If I understand this right here, we can get rid of this "make a unique version script" since the version should be unqiuely identified by a commit and it doesn't really make sense to run this twice on the same commit

@d-v-b
Copy link
Copy Markdown
Contributor Author

d-v-b commented May 6, 2026

@ilan-gold good point, that script is now gone

@ilan-gold ilan-gold mentioned this pull request May 6, 2026
Merged
6 tasks
@ilan-gold
Copy link
Copy Markdown
Contributor

ilan-gold commented May 6, 2026 •
edited
Loading

Ok so my comment here was right. My above comment assumes you are using hatch-vcs. Would you be interested in that @d-v-b? I could apply it to both this and the top-level package since we seem to be using hatch here.

@ilan-gold
Copy link
Copy Markdown
Contributor

ilan-gold commented May 6, 2026

I become so used to our own dev setup, I forget what doesn't happen by default!

@d-v-b
Copy link
Copy Markdown
Contributor Author

d-v-b commented May 6, 2026 •
edited
Loading

Ok so my comment here was right. My above comment assumes you are using hatch-vcs. Would you be interested in that @d-v-b? I could apply it to both this and the top-level package since we seem to be using hatch here.

Yes, vcs versioning for zarr metadata would be great! I think we can define a regex that matches git tags like zarr-metadata/<version>

@ilan-gold
Copy link
Copy Markdown
Contributor

ilan-gold commented May 6, 2026

Ok will have a look in the morning!

ilan-gold
ilan-gold reviewed May 17, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ilan-gold ilan-gold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What immediately jumps out at me (I think claude mentioned this) is documenting this convention, probably in the README.md for this package.

d-v-b
d-v-b commented May 17, 2026
View reviewed changes
Comment thread packages/zarr-metadata/README.md
defined in `zarr-extensions`. We are generally open to contributions that
add types for Zarr metadata with a published spec.

## Releasing
Copy link
Copy Markdown
Contributor Author

@d-v-b d-v-b May 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ilan-gold how does this look

@d-v-b
Copy link
Copy Markdown
Contributor Author

d-v-b commented May 17, 2026

A change worth noting: to ensure that the github releases page only shows zarr-python releases, zarr-metadata is released by pushing tags. this is documented in the zarr-metadata readme.

@d-v-b d-v-b merged commit f2321ec into zarr-developers:main May 17, 2026
39 checks passed
@d-v-b d-v-b deleted the chore/publish-metadata-package branch May 17, 2026 21:34
d-v-b added a commit to d-v-b/zarr-python that referenced this pull request May 18, 2026
@d-v-b @claude
Merge origin/deprecate-more-enums into deprecate-more-enums
03443fb 
Pulls in the upstream-main work that landed on the remote branch after
the previous local merge: PR zarr-developers#3975 (refactor _ShardIndex to store
chunks_per_shard explicitly), PR zarr-developers#3908 (cache default ArraySpec),
zarr-developers#3935 (cd workflow), zarr-developers#3978 (zarr-metadata constants), zarr-developers#3979 (drop
fixed-length utf32 warning).

Conflicts resolved:

- src/zarr/codecs/sharding.py imports: drop the now-unused
  `from operator import itemgetter` per zarr-developers#3975, keep our
  `ClassVar, Final, Literal` additions for the enum-deprecation types.
- tests/test_codecs/test_sharding.py imports: combine
  `from zarr.core.metadata.v3 import ArrayV3Metadata` (ours, for the
  dict-shards coverage test) with `from zarr.core.indexing import
  c_order_iter` (theirs, for the new vectorized-slice tests).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ilan-gold ilan-gold ilan-gold approved these changes

@maxrjones maxrjones Awaiting requested review from maxrjones

Assignees

No one assigned

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@d-v-b @ilan-gold